/**
 * Elements Collection
 *
 * @Resource("Elements", uri="/elements")
 *
 * @DataStructures({
 *     @Type("Element", type="object", properties={
 *          @Property("id", type="number", description="Internal identifier", sample=1),
 *          @Property("name", type="string", description="Element name", sample="element")
 *     }),
 *     @Type("Pagination", type="object", properties={
 *          @Property("total", type="number", description="Total items", sample=9),
 *          @Property("per_page", type="number", description="Items per page", sample=3)
 *     }),
 *     @Type("Meta", type="object", properties={
 *          @Property("pagination", type=@Type("Pagination"), description="Pagination information")
 *     })
 * })
 */
class ElementController extends BaseController {

    /**
     * Show all elements
     *
     * Get a JSON representation of all the elements
     *
     * @Get("/")
     * @Response(200, attributes={
     *     @Attribute("success", type="boolean", sample="true", required=true, description="Status of the request"),
     *     @Attribute("data", type={@Type("Element")}, description="Element data", required=true),
     *     @Attribute("meta", type=@Type("Meta"), description="Meta information", required=true)
     * })
     */
    public function index()
    {
        // This definition results in the following response:
        //
        // {
        //  "success": true,
        //  "data": [
        //    {
        //      "id": 1,
        //      "name": "element"
        //    }
        //  ],
        //  "meta": {
        //      "pagination": {
        //          "total": 9,
        //          "per_page": 3
        //      }
        //  }
        //}
    }

    /**
     * Show specific element
     *
     * Get a JSON representation of a specific element
     *
     * @Get("/{element_id}")
     *
     * @Response(200, attributes={
     *     @Attribute("success", type="boolean", sample="true", required=true, description="Status of the request"),
     *     @Attribute("data", type=@Type("Element"), description="Element data", required=true)
     * })
     * @Parameters({
     *      @Parameter("element_id", type="integer", required=true, description="The element's id", example=1)
     * })
     */
    public function show()
    {
        // This definition results in the following response:
        //
        // {
        //  "success": true,
        //  "data": {
        //    "id": 1,
        //    "name": "element"
        //  }
        //}
    }
}